receiveQualityNotification

Receives a new quality notification

application/json

Request Body

• header object required

  notificationId uuid required

  A UUIDv4 to uniquely identify a quality notification.

  senderBPN string required

  The business partner number (BPN) of the sender.

  senderAddress uri required

  The Eclipse Dataspace Connector (EDC) URL of the sender.

  recipientBPN string required

  The business partner number (BPN) of the receiver.

  classification string required

  Possible values: [QM-Investigation, QM-Alert]

  The classification defines the type of quality notification.

  severity string required

  Possible values: [MINOR, MAJOR, CRITICAL, LIFE-THREATENING]

  The severity of the quality notification describes its criticality.

  relatedNotificationId uuid

  A UUIDv4 to uniquely identify a related quality notification.

  status string required

  Possible values: [CREATED, SENT, RECEIVED, ACKNOWLEDGED, ACCEPTED, DECLINED, CLOSED]

  The status of the quality notification.

  targetDate date-time

  The date and time when a processing of the notification is expected by the sender.

  messageId uuid required

  A UUIDv4 to uniquely identify an individual quality notification message. In case of an initial sending of a notification the messageId has to be a newly generated UUIDv4.

• content object required

  information string

  Possible values: <= 1000 characters

  listOfAffectedItems string[] required

Responses

• 201
• 400
• 401
• 403
• 405
• 409
• 422

---

Quality notification was received successfully

Request body was malformed

Not authorized

Forbidden

Method not allowed

Could not accept the send quality notification, because a quality notification with that notificationId already exists

Could not accept the send quality notification even though it is syntactically correct. The quality notification is not accepted, because of semantic reasons (e.g., an affected item is not known by the receiver).

Loading...